home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / qrdb34.zip / QRDB.DOC < prev    next >
Text File  |  1993-05-17  |  40KB  |  821 lines
  1.  
  2.  
  3.                            QRDB  Vers 3.4                 17 May 93
  4.                       Mountain Retreat Software
  5.  
  6.                                 QRDB
  7.                 (c) Copyright 1992 by John Jamieson
  8.                          All Rights Reserved
  9.  
  10.  
  11. Intro:
  12.  
  13.   QRDB/QRDBMgr is a Data Base system for BBS's that use DorInfo1.Def.
  14.   QRDB is a multi-node compatable BBS Data Base door and QRDBMGR is the
  15.   Data Base Manager. Although QRDB was designed to be used as a BBS door
  16.   it can be used by users without a BBS if needed. A BBS is not required
  17.   in order to run the program, it will run in local mode.
  18.  
  19.  
  20. QRDB/QRDBMgr offers three types of Data Base.
  21.  
  22.   Type 1 will import any text file in which the data is layed out in
  23.   columns. The imported Data Base can then be made available to BBS
  24.   users for searches or sorted list displays. Up to five keys can be
  25.   designated making five sorted lists available to the user.  This Type
  26.   1 Data Base is not editable and a Data Record is limited to 80
  27.   characters. An example of a file suitable for import is the Darwin BBS
  28.   listing.
  29.  
  30.   Type 2 is a build from scratch Data Base. The user can Add, Edit and
  31.   Delete records in the Type 2 Data Base. Read, Write and Edit/Del
  32.   levels are established by the Sysop. A log is maintained of all
  33.   Additions, Edits and Deletes made by users. This type 2 Data Base can
  34.   contain up to 25 fields per Record with a maximum of 5 Key fields. 5
  35.   display lines with 5 fields per line max.  Fields can be designated as
  36.   input optional or input required. QRDB can import comma delimited
  37.   files into the type 2 Data Base.
  38.  
  39.   Type 3 will display data in dBase .DBF data files and .DBT memo files.
  40.   The dBase Data can then be made available to BBS users for searches or
  41.   sorted list displays. Up to five keys can be designated making five
  42.   sorted lists available to the user. The user can Add, Edit and Delete
  43.   records in the Type 3 Data Base. Read, Write and Edit/Del levels are
  44.   established by the Sysop. A log is maintained of all Additions, Edits
  45.   and Deletes made by users. All fields except the Memo's are searched
  46.   when using the Search function.
  47.   QRDB LIMITS on dBase files are as follows. QRDB will only handle 20
  48.   dBase records with 20 or less fields. The number of memo's is limited
  49.   to 3 per record and the lines in a memo are limited to 20 with a
  50.   maximum line length of 76 characters.
  51.  
  52.  
  53. User Access to data
  54.  
  55.   Access to files is controlled by Levels established for each DataBase.
  56.   Read, Write and Edit/Delete levels are seperatly controlled.
  57.   In addition to access provided under level control, a user is given
  58.   access to any record that he/she creates. This Record access is
  59.   controled by the index files identified *O.IDX. This feature can be
  60.   disabled by deleting the *O.IDX file after the user exits QRDB. QRDB
  61.   will build a new empty *O.IDX if it dosen't find one.
  62.   An example of the posibilities:
  63.   A user can be given Add, Edit/Delete access and No Read access. In
  64.   this situation a user database, that only the Sysop or CoSysops with
  65.   read access would have access to all the records, could be built and
  66.   maintained by users.
  67.  
  68.  
  69. The advantages/disadvantages of each type are as follows:
  70.     Type 1: Imports text layed out in columns.
  71.             Only displays, no edits.
  72.             User Read Access controlled by security level
  73.  
  74.     Type 2: Data base can be built on line.
  75.             Imports comma delimited files
  76.             Exports to comma delimited files
  77.             User access to Read, Add, Edit and/or Delete controlled
  78.             by user Level
  79.  
  80.  
  81.     Type 3: Data base uses dBase .DBF and .DBT files
  82.             Checks date entries for validity
  83.             Checks numeric entries
  84.             dBase Memo capability, a great feature
  85.             Requires dBase Compatable files
  86.             User access to Read, Add, Edit and/or Delete controlled
  87.                 by user Level
  88.  
  89.             dBase Compatable files can be created with the Shareware
  90.             utility dBuddy. Additional dBuddy info is below.
  91.  
  92.  
  93. Example QRDB main Menu and Status Bar:
  94.  
  95. ╔════════════════════════════════════════════════════════════════════════╗
  96. ║            ░░▒▒▓▓██  Q R D B    M A I N    M E N U  ██▓▓▒▒░░           ║
  97. ║                                                                        ║
  98. ║  ░▒              Mountain Retreat DataBase Selection               ▒░  ║
  99. ╠════════════════════════════════════════════════════════════════════════╣
  100. ║  A    Fido Net BBS's in North America                                  ║
  101. ║  B    Fido Net BBS's Outside N. America                                ║
  102. ║  C    Darwin National BBS List                                         ║
  103. ║  D    System User's                                                    ║
  104. ║  E    WildCat BBS's in the North America                               ║
  105. ║  F    User Generated List of Area Code 408 BBS's                       ║
  106. ║  G    Hardware/Software Industry Support BBS's                         ║
  107. ║  H    User Generated List of Out of Area Boards                        ║
  108. ║  I    Computer Hwd/SW Suppliers support (Not BBS's)                    ║
  109. ║                                                                        ║
  110. ║  ?    Help                                                             ║
  111. ║  X    Exit QRDB                                                        ║
  112. ╠════════════════════════════════════════════════════════════════════════╣
  113. ║      QRDB Door - Mt. Retreat Software - Support BBS (408)335-4595      ║
  114. ╚════════════════════════════════════════════════════════════════════════╝
  115.  Selection:
  116.  
  117. ┌───────────────────────────────────────────────────────────────────────────┐
  118. │John Jamieson                 Level=100     Baud=2400        Graphics=On   │
  119. │Felton, Ca                    Min's Left=67                  Alt-H= Hangup │
  120. └───────────────────────────────────────────────────────────────────────────┘
  121.  
  122.  
  123.  
  124. Quick Start:
  125.  
  126.   A few sample Data Bases are included in the package. Just place the
  127.   QRDB package of files in their own directory and run QRDB or QRDB /M
  128.   for Local in monochrome, and follow the Prompts. The Darwin Data Base
  129.   related files included with the package contains a setup only, no
  130.   data, it's use will be discussed later. Feel free to use any of the
  131.   examples on your BBS or delete them using the QRDBMgr or DOS. It is
  132.   suggested that you review the Example setups prior to deleting them.
  133.   Run the QRDBMgr and press F2 to call up the control file editor. The
  134.   editor can be used to review the setups.
  135.  
  136.   To Run QRDB as a door add the Environment Variable SET QRDB=C:\QRDB,
  137.   set it to whatever directory QRDB is located in. If the Environment
  138.   Variable is not set you must run QRDB from the QRDB directory. QRDB
  139.   uses the Environment Variable to locate the the QRDB files, and if
  140.   they are not found you will get the error message "QRDB.KEY not found
  141.   or Corrupt. After seting the Environment variable,  create a
  142.   QuickBBS/RA type 7 menu type and in the Optional data field just place
  143.   the command C:\QRDB\QRDB.EXE *M  that's all their is to it. QRDB, when
  144.   running as a door, needs access to DorInfo1.Def. QRDB must be run from
  145.   a directory containing DorInfo1.Def.
  146.  
  147.   QRDB defaults to Local mode, without a status line, if it can't find
  148.   DorInfo1.Def. It will also run in local  Local mode, but with a status
  149.   line if the baud rate it finds in DorInfo1.Def is 0.
  150.  
  151.   The Main menu can be bypassed. A couple of reasons for bypassing are;
  152.   if only one data base is to be included or the sysop would rather use
  153.   the BBS menus to access the data bases. Bypassing is accomplished by
  154.   executing QRDB with the name of the CL file as a command line
  155.   parameter. Example  C:\QRDB\QRDB.EXE CHAPLIN.3CL *M  or if running
  156.   stand-alone local mode  QRDB.EXE CHAPLIN.3CL. To run in stand-alone
  157.   local mode, but monochrome use  QRDB.EXE /M CHAPLIN.3CL.
  158.  
  159.  
  160.  
  161. Files:
  162.  
  163.   A set of files will be created for each Data Base
  164.    .1CL,.2CL or .3CL  Control file; a Type 1,2 or 3
  165.    .Dat     Data file;  for type 1 & 2 only, type 3 uses your.DBF file
  166.    .IDX     Index file; 1 to 5 as specified during setup
  167.  
  168.   A QRDB general help file will be displayed from the main menu, if you
  169.   name it QRDB.HLP. You can also create a .HLP file for each Data Base by
  170.   using the same name as your Data Base. If a help file is found it will
  171.   be offered to the user in the QRDB menus. .HLP files are just text
  172.   files.
  173.  
  174.   When assigning file names you will be allowed 7 characters instead of
  175.   the usual 8. QRDB needs that 8th character.
  176.  
  177.   A Data Base consisting of a set of the above files is a stand alone
  178.   package. It can be copied/moved to another BBS that uses QRDB or it
  179.   can be deleted from your QRDB directory. QRDBMgr has a delete function,
  180.   it's there only for convenience DOS is all that is needed.
  181.  
  182.   The files provided with the package are the following :
  183.  
  184. QRDBMGR.EXE     The QRDB Manager used to set up data bases for QRDB
  185. QRDB.EXE        The QRDB BBS Door
  186. QRDB.TTL        A file that stores the title you give to the QRDB Main Menu
  187. QRDB.DOC        This File
  188. QRDB.KEY        Key to QRDB operation
  189. QRDB.HLP        A Sample general help file
  190.  
  191.      ** The following files are example files and can
  192.          be deleted when you are finished with them.
  193.  
  194. SUPPORT.1CL     Type 1 Sample Control File  (List of Support BBS's)
  195. SUPPORT.DAT     Type 1 Sample Data File
  196. SUPPORT.HLP     Support Data Base Help File (Text)
  197. SUPPORT1.IDX    Type 1 Sample Index file #1
  198. SUPPORT2.IDX    Type 1 Sample Index file #2
  199. SUPPORT.TXT     Text file used in the creation of the Type 1 Sample
  200.  
  201. BBSLIST.2CL     Type 2 Sample Control File (User generated BBS List)
  202. BBSLIST.DAT     Type 2 Sample Data File
  203. BBSLIST.HLP     BBSList Data Base Help File (Text)
  204. BBSLIST1.IDX    Type 2 Sample Index file #1
  205. BBS.LST         A sample comma delimited file for import into
  206.                  the BBSLIST data base
  207.  
  208. WGUIDE.2CL      Type 2 Sample Control File (Wine Guide)
  209. WGUIDE.DAT      Type 2 Sample Data File
  210. WGUIDE.HLP      WGuide Data Base Help File (Text)
  211. WGUIDE1.IDX     Type 2 Sample Index file
  212. WGX.CTL         Control file for Export of WGuide to Comma Delimited file
  213. WGX.TXT         Comma Delimited Exported database
  214.  
  215. USERDAT.2CL     Type 2 Sample Control File (User DataBase)
  216. USERDAT.DAT     Type 2 Sample Data File
  217. USERDAT1.IDX    Type 2 Sample Index
  218.  
  219. USERINF  3CL    Type 3 Sample Control File (User DataBase as above but dB3)
  220. USERINF  DBF    dBase .DBF file used by QRDB
  221. USERINF  DBT    dBase .DBT Memo file used by QRDB
  222. USERINF1 IDX    Type 3 Sample Index
  223.  
  224. CHAPLIN.3CL     Type 3 Sample Control File  (Chaplin dBase Data Base)
  225. CHAPLIN.DBF     dBase .DBF file used by QRDB
  226. CHAPLIN.DBT     dBase .DBT Memo file used by QRDB
  227. CHAPLIN.HLP     Chaplin Data Base Help File (Text)
  228. CHAPLIN1.IDX    Type 3 Sample Index file
  229.  
  230. USBBS.1CL       Type 1 Sample Control File (Setup for Darwin USBBS list)
  231. USBBS.DAT       Empty Type1 Sample Data File
  232. USBBS.HLP       USBBS Data Base Help File (Text)
  233. USBBS1.IDX      Type 1 Sample Index file #1
  234. USBBS2.IDX      Type 1 Sample Index file #2
  235. USBBS3.IDX      Type 1 Sample Index file #3
  236.  
  237. The complete chaplin dBase package can be download from Mountain Retreat
  238. only the .DBF & .DBT file are included here. The Complete package
  239. includes Chaplin.FMT. Since QRDB only reads .DBF and .DBT files I didn't
  240. include the conplete package.
  241.  
  242. The files provided will appear in the QRDB main menu as follows:
  243.  
  244. ╔════════════════════════════════════════════════════════════════════════╗
  245. ║            ░░▒▒▓▓██  Q R D B    M A I N    M E N U  ██▓▓▒▒░░           ║
  246. ║                                                                        ║
  247. ║  ░▒                  Your BBS DataBase Selection                   ▒░  ║
  248. ╠════════════════════════════════════════════════════════════════════════╣
  249. ║  A    Computer Hardware/Software Support                               ║
  250. ║  B    Darwin National BBS List                                         ║
  251. ║  C    User List of Favorite BBS's                                      ║
  252. ║  D    User Data Base                                                   ║
  253. ║  E    Central California Winery Guide                                  ║
  254. ║  F    A Data Base of Chaplin Movies                                    ║
  255. ║  G    DataBase of BBS user info                                        ║
  256. ║                                                                        ║
  257. ║  ?    Help                                                             ║
  258. ║  X    Exit QRDB                                                        ║
  259. ╠════════════════════════════════════════════════════════════════════════╣
  260. ║      QRDB Door - Mt. Retreat Software - Support BBS (408)335-4595      ║
  261. ╚════════════════════════════════════════════════════════════════════════╝
  262.  Selection:
  263.  
  264.   In the menu above the "User Data Base" is a type 2 data base and
  265.   "DataBase of BBS user info" is a similar data base useing a type
  266.   3 data base with memo's
  267.  
  268.  
  269. Trouble shooting the QRDB door installation:
  270.  
  271.   The Status bar can be an aid in trouble shooting the door installation.
  272.   a.  No status bar indicates that the DorInfo1.Def file was not found and
  273.       QRDB is running in local mode.
  274.   b.  A status bar with a Baud rate other than 0 indicates the DorInfo1.Def
  275.       file has been read, QRDB has Config and user info and is running as
  276.       a door.
  277.   c.  If the status bar shows a baud rate of 0 then DorInfo1.Def has been
  278.       Read and QRDB is running in local mode.
  279.   d.  If double spaceing or blank lines in a occure in records when
  280.       displaying it's probably due to, too much data being placed on a
  281.       line. Go back to the QRDBMgr and do some rearranging.
  282.  
  283.  
  284. QRDBMgr:
  285.  
  286.   QRDBMgr.EXE is used to setup a data base, create/edit control files,
  287.   import data and generate index files.
  288.  
  289.   QRDBMgr can be used with or without a mouse. If running without a
  290.   mouse use the arrows keys to select menu items and the Tab key to
  291.   Select Entry fields or Buttons. Main menu items are selected by
  292.   pressing the Alt key plus the HighLighted letter in the menu item
  293.   description.
  294.  
  295.   The diagram below shows the menu selections that are available in
  296.   QRDBMgr.
  297.  
  298.   Remember the Data_Base_Setup functions only put together a control
  299.   file. If you are creating a type 1 data base you will still need to
  300.   import the data using the Import_Type_1_DB_Data function.  In the case
  301.   of a type 3 data base the Build_Type_3_DB_Index function will create
  302.   the necessary indexes to the .DBF file. QRDB does NOT use dBase index
  303.   files.
  304.  
  305.   Qnce a Data Base contains Data/Indexes, changes to certain fields will
  306.   no longer be allowed. You will receive a message telling you which
  307.   fields can't be edited when you attempt to edit a Data Base containing
  308.   data. If you need to edit one of those fields the only way is to Erase
  309.   the data using the Manager's Erase function, make the necessary
  310.   changes and then Import, Build or Re-enter the data.
  311.  
  312.   When Erasing Index/Data only Indexes/Data created by QRDB is erased.
  313.   In the case of a type 2 database that's data and indexes, in the case
  314.   of a type 3 that's only indexes, it won't delete the dBase files. The
  315.   delete function will also delete the setup.
  316.  
  317.  
  318.  
  319. ┌──────────────────────────────────────────────────────────────────────────┐
  320. │ Exit  Data_Base_Setup           Operations        Shell_to_QRDB          │
  321. └──────────────┬───────────────────────┬─────────────────┬─────────────────┘
  322.                │                       │                 │
  323.                │                       │                 │
  324.                │                       │                 │
  325.   ┌────────────┴─────────────┐         │                 │
  326.   │ Edit a DB Setup       F2 │         │                 │
  327.   │ Make a New Type 1 DB  F4 │         │                 │
  328.   │ Make a New Type 2 DB  F5 │         │                 │
  329.   │ Make a New Type 3 DB  F6 │         │                 │
  330.   └──────────────────────────┘         │                 │
  331.                                        │                 │
  332.                             ┌──────────┴───────────────┐ │
  333.                             │ Main Menu Title Edit     │ │
  334.                             │ Import Type 1 DB Data    │ │
  335.                             │ Read in Type 2 DB Data   │ │
  336.                             │ eXport Type 2 DB Data    │ │
  337.                             │ Build Type 3 DB Index    │ │
  338.                             │ Copy a Type 1 or 2 Setup │ │
  339.                             │ Delete a DataBase        │ │
  340.                             │ Erase QRDB Index/Data    │ │
  341.                             └──────────────────────────┘ │
  342.                                                          │
  343.                                                     ┌────┴───────┐
  344.                                                     │ Color   F8 │
  345.                                                     │ Monochrome │
  346.                                                     └────────────┘
  347.  
  348.  
  349. Creating a Type 1 Data Base
  350.  
  351.   To create a Type 1 Data Base you will need a text file to import. The
  352.   USBBS list by Darwin Systems is a good file to start with. Any list
  353.   you chose to create a Type 1 Data Base from must be one in which the
  354.   data is arranged in columns. QRDB will extract it's keys from those
  355.   columns during conversion. Remove any material that isn't a part of
  356.   the structured data, such as column descriptions or List name. Column
  357.   descriptions are entered during setup, using QRDBMgr. Other info
  358.   removed from the list can be placed in the USBBS.HLP help file if
  359.   desired. A Data Base has already been setup for the USBBS list, select
  360.   the menu item Edit_a_DB_Setup or press F2 to review the setup. If you
  361.   are not going to use the Darwin USBBS list in your Data Base you can
  362.   delete it with the Delete a Data Base Function. If you are going to
  363.   use the USBBS you will need to obtain and edit a copy. Remove all text
  364.   at the begining and end of the list that isn't in structured in
  365.   columns. When you are ready to import your USBBS list select menu item
  366.   Import_Type_1_DB_Data from the Operations menu. A Dialog box will be
  367.   presented listing available control files, select USBBS.1CL, next
  368.   enter the name of the USBBS list that you want to import. After you
  369.   have imported the list you can select menu item Shell_to_QRDB and
  370.   review the new data base.
  371.  
  372.   To create a Data Base other than the USBBS that was provided. Start by
  373.   determining what fields that you want to be key fields, you can have up
  374.   to 5. Now Press F4 to bring up the Make Type 1 DB Dialog Box. You will
  375.   enter Database Name, Data Base Title, Display Header and Read Level.
  376.   The Data Base title is the title that will be displayed in the QRDB
  377.   main menu. The header will be displayed with each page of data. Read
  378.   level is the minimum user level required for access to the data. Use
  379.   the Tab or Mouse to select fields.
  380.  
  381.   Example:
  382.  
  383.      Database Name      SUPPORT
  384.  
  385.      Data Base Title    Computer Hardware/Software Support
  386.  
  387.      Display Header       Company Name            Phone Number     Remarks
  388.  
  389.      Read Level         1
  390.  
  391.  
  392.   Press OK when done or press enter. Next a Dialog Box will be presented
  393.   for the defining of keys.
  394.                                          Key
  395.     Key                      Key         Position
  396.     Search Prompt            Length      in Line
  397.  
  398.     Phone Number             12          31
  399.     Company Name             5           25
  400.  
  401.   At least one Key must be defined. Key Search Prompt is the Prompt QRDB
  402.   will use to describe the key to the user. Key Length is the length of
  403.   the key and Key Position in Line is the starting column that QRDBMgr
  404.   will use when extracting keys during import. 
  405.  
  406.   After the setup has been completed the function Import_Type_1_Db_Data
  407.   will import your textfile into the data base, the function builds
  408.   indexes and a .DAT file. QRDB limits the width of text imported into
  409.   this type 1 data base to 79 characters. More than one text file of
  410.   identical structure can be imported if necessary.
  411.  
  412.   The import feature can be used to add a chunk to an existing data
  413.   base, it is suggested you backup any existing work before importing
  414.   additional data. QRDBMgr does not check the data you are importing and
  415.   improperly structured input could corrupt the data base.
  416.  
  417. Creating a Type 2 Data Base
  418.  
  419.   A couple of sample Type 2 Data Base files have been provided. To
  420.   review their control files, run QRDBMgr press F2 and select
  421.   either of the .2CL files.
  422.  
  423.   Prior to creating a Type 2 Data Base you should first decide on the
  424.   layout of the data that will be presented to the user. The number of
  425.   lines it will take to display a record and the layout of each line. A
  426.   maximum of 5 lines and a maximum of 5 fields per line are allowed.
  427.   Decide witch fields will be (K)ey fields, input (R)equired Fields or
  428.   Input (O)ptional fields. All Key fields are also input required
  429.   fields. The space used to display fields on a line can't add up to
  430.   more than 80 characters. Space required to display a field is the
  431.   length of the data field + the length of the Data Label + a colon and
  432.   a space between label and data. If not enough space is available
  433.   for the full field of the last record on a line the field will be
  434.   truncated.
  435.  
  436.   Note that the QRDB (L) and (B) functions will use the first key
  437.   assigned for their sort order. Another thing to consider is that the
  438.   QRDB (B)rowse function first displays that first key, then starting at
  439.   the first field in the record it displays fields until 80 characters
  440.   are displayed then goes to the next record. If the Key field displayed
  441.   at the beginning of the line is incountered it is skiped. Spacing used
  442.   by (B)rowse is Field Length plus 2 spaces unless the length or the
  443.   display label is greater than the field length, in which case (B)rowse
  444.   will use the display label length.
  445.  
  446.   When the layout has been planed, press F5 or select Add_a_type_2_DB
  447.   from the menu to bring up the Make Type 2 Dialog Box. Fill in the
  448.   Database Name, Read Write and Edit/Del Security Levels and the Data Base
  449.   Title. Use the Tab or Mouse to select fields.
  450.  
  451.   Example:
  452.  
  453.      Database Name:   AREA408
  454.  
  455.      Security Levels  Read      Write     Edit/Del
  456.                        5         5         100
  457.  
  458.      Data Base Title:  User Generated List of Area Code 408 BBS's
  459.  
  460.  
  461.   Press OK when done or press enter. Next a Dialog Box will be presented
  462.   for the defining the first line of the Data Base. You can have up to 5
  463.   lines. The inputs required to define a line are as follows.
  464.  
  465.  
  466.   Example:
  467.  
  468.  ┌─────  Input  ────────────────────────┐ ┌──────────  Display  ──────────┐
  469.  │(K)ey                                 │ │                         Label │
  470.  │(R)eq                           Field │ │                         Start │
  471.  │(O)pt Prompt                    Length│ │Label                    Column│
  472.    K    Phone Number [XXX-XXXX     8       Phone                     1
  473.    K    City                       25      City                      21
  474.    O    Max Baud                   5       Max Baud                  56
  475.                                    0                                                                       0
  476.  
  477.  
  478.   Up to 5 fields per line can be defined, but only a total of 5 keys in
  479.   the 5 lines are all that is allowed. Remember that the total of fields
  480.   and field labels can't add up to more than 80. Oh also allow for
  481.   spaces between fields and Colons after labels.
  482.  
  483.   Maximum key length is 15 characters if a field longer than 15
  484.   characters is designated as a key only the 1st 15 characters in the
  485.   field will be used in the index.
  486.  
  487.   When you have defined the first line press Alt N or use the mouse to
  488.   select the next line button or you can press enter. When you have
  489.   defined the last line that you want to use Select the Done button.
  490.  
  491.  
  492.   Input Info .......
  493.  
  494.   (K)ey-(R)eq-(O)pt    decide if the field will be a (K)ey field, an input
  495.                        (R)equired Field or an Input (O)ptional field. All
  496.                        Key fields are also input required fields.
  497.  
  498.   Prompt               This is the Prompt QRDB will use when asking for Input
  499.                        or describing the sorted lists that are possible.
  500.  
  501.   Field Length         This is the Maximum length of an entry in this field.
  502.                        If it is a Key field it is also the length of the Key
  503.                        unless the field is longer than 15 characters in
  504.                        which case the Key length is set to 15 characters.
  505.  
  506.   Display Info .....
  507.  
  508.   Label                This is the label placed ahead of the data when the
  509.                        line is displayed, when displayed a colon will be added
  510.                        to the label.
  511.  
  512.   Label Start Column   This is column that the first character in the label
  513.                        will be placed in. When a field is displayed the
  514.                        label is followed by a colon and a space and then
  515.                        the data. Labels are not displayed if the field
  516.                        is empty.
  517.  
  518.  
  519.   The data base can be left empty for user input or a comma delimited
  520.   file of data can be imported into the data base using the Operations
  521.   PullDown Menu item (Read in Type 2 DB Data). Data for import must be
  522.   set up as follows. Each record to be created must contain the same
  523.   number of lines that you have established for display by QRDB. Use a
  524.   comma to identify the end of a field's input. A comma is required for
  525.   every field in the record, including blank fields. Remember not to use
  526.   comma's in your data as they would throw things off. See the following
  527.   example.
  528.  
  529. A record from the Example Data Base "User List of Favorite BBS's"
  530.  
  531. │Phone: 408-335-4595   St: Ca    City: Felton
  532. │BBS Name: Mountain Retreat
  533. │MaxBaud: 14400   Size: 660Meg
  534. │Comment: Specializing in Pascal Programming
  535.  
  536. A comma delimited text file for import would look as follows
  537.  
  538. 408-371-7654,Ca,Campbell,
  539. Brown Bag Software,
  540. 2400,,
  541. Brown Bag software support board,
  542. 201-471-6391,Nj,Passaic,
  543. The Passaic/NJPCUG BBS,
  544. 9600,,
  545. Fido Net Node 1:107/559,
  546. 714-824-4328,Ca,Loma Linda,
  547. LLUMC Online Medical Library,
  548. 2400,120Meg,
  549. ,
  550.  
  551.   In summary:
  552.   No blank lines, one line for each line in the record, Comma at the end
  553.   of each field including blank fields. No testing of your input is done
  554.   by QRDBMgr so make sure your input is correct and if you are adding to
  555.   an existing data base you should probably back up the data base before
  556.   starting.
  557.  
  558.   If you are going to import a comma delimited list; select menu item
  559.   Read_In_Type_2_DB_Data from the Operations menu. A Dialog box will be
  560.   presented listing available control files, select the .2CL control
  561.   file for the data base you want to add to, next enter the name of the
  562.   list that you want to import. After you have imported the list you can
  563.   select menu item Shell_to_QRDB and review the new data base.
  564.  
  565.   The import feature can be used to add a chunk to an existing data
  566.   base, it is suggested you backup any existing work before importing
  567.   additional data. QRDBMgr does not check the data you are importing and
  568.   improperly structured input could corrupt the data base.
  569.  
  570. Exporting Type 2 Data
  571.  
  572.   QRDB will Export Type 2 DB Data to a Comma delimited file. Output will
  573.   be based on the record structure and will be in the format required
  574.   for import. Or you can format the data thru the use of a control file.
  575.   Control File structure is as follows, You will need a line in the
  576.   control file for each line of record output required. Identify the
  577.   line with the line number preceded by "L" as L1. Then on that line
  578.   identify the fields that are to be placed on the line using a
  579.   combination of Line that the record is found on a Dos Pipe character
  580.   and the position of the field on the line.
  581.  
  582.   Control files must have the Extension .CTL and the same name as the
  583.   Comma delimited Text file being created. Example if WGX1.TXT is the
  584.   name of the text file being created then WGX1.CTL would be the name to
  585.   use for the control file
  586.  
  587.   The following is an example control file. It consists of the one line:
  588.  
  589. L1  2|1 1|1
  590.  
  591.   The above will export the BBS name and Phone number from the example
  592.   "User List of Favorite BBS's" to a comma delimited file. The name and
  593.   phone number will appear on one line in the output. In order to place
  594.   the data on two lines the control file would look as follows
  595.  
  596. L1  2|1
  597. L2  1|1
  598.  
  599.   To export to a comma delimited file, in which records are written one
  600.   to a line, you would use something like the following. The fields can
  601.   be placed in any order required.
  602.  
  603. L1 1|1 1|2 1|3 2|1 3|1 3|2 4|1
  604.  
  605.  
  606. Creating a Type 3 Data Base
  607.  
  608.   A sample Type 3 Data Base has been provided. To review  it's
  609.   control files, run QRDBMgr and press F2 and select the .3CL file.
  610.  
  611.   As with the type 2 data base you should have a plan as to how you want
  612.   the data to be displayed. Note that the QRDB (L), (M) and (B) functions
  613.   will use the first key assigned for their sort order. Another thing to
  614.   consider is that the QRDB (B)rowse function first displays that first
  615.   key, then starting at the first field in the record it displays fields
  616.   until 80 characters are displayed then goes to the next record. If the
  617.   Key field displayed at the beginning of the line is incountered it is
  618.   skiped. Spacing used by (B)rowse is Field Length plus 2 spaces unless
  619.   the length or the display label is greater than the field length, in
  620.   which case (B)rowse will use the display label length.
  621.  
  622.   The dBase date field is converted to MM/DD/YYYY when displayed. When
  623.   listing by date field order when the date field is a Key field, QRDB
  624.   converts user input from ,MM/DD/YYYY, MM-DD-YYYY, or MM/DD/YY to the
  625.   dBase format YYYYMMDD. If users will be wanting to search for dates
  626.   that are in dBase date fields, it would be a good idea to make the
  627.   date field a Key field as the search function does not do any
  628.   converting.  Look at the chaplin dbase file and help screen for an
  629.   example.
  630.  
  631.   When you have a plan press F6 or select Add_a_type_3_DB from the menu
  632.   to bring up the Make Type 3 Dialog Box. Fill in the Name of the .DBF
  633.   file you are going to use. If the dBase file is not in the QRDB
  634.   directory you will need the Full Path Name. A minor problem created by
  635.   the Full Path Name is if the database is passed to another system the
  636.   dBase file must be placed in a directory with the identical name, not
  637.   a problem if the database is used on one machine. Next input Security
  638.   Levels and the Data Base Title. Use the Tab or Mouse to select fields.
  639.  
  640.   Example:
  641.  
  642.     .DBF file Name:    CHAPLIN.DBF  (or C:\dBase\Chaplin.Dbf)
  643.  
  644.     Read Security Level:   1
  645.  
  646.     Data Base Title:     A data base of Chaplin movies
  647.  
  648.   Press OK when done or press enter. Next a Dialog Box will be presented
  649.   for the defining the layout of the dBase data on the screen.
  650.  
  651.   Example:
  652.  
  653. ╔═[■]═══════════════════════ Type 3 Db  Fields  ════════════════════════
  654. ║ ┌─ dBase Field ───┐ ┌────────── QRDB Handling Instructions ──────────┐
  655. ║ │                 │ │(N)/A                                           │    ║
  656. ║ │                 │ │(O)pt                                           │    ║
  657. ║ │                 │ │(R)eq                                           │    ║
  658. ║ │Name      Typ Len│ │(K)ey  Display Label                   Line Col │    ║
  659. ║
  660. ║  TITLE      C  30      O     Title                           1    1
  661. ║  COMPANY    C  15      O     Company                         1    38
  662. ║  RELEASE_D  D  10      K     Released                        4    1
  663. ║  DIRECTOR   C  30      O     Director                        3    1
  664. ║  WRITER     C  30      O     Writer                          3    38
  665. ║  FEETLENGT  N  5       N                                     0    0
  666. ║  FEET_SHOT  N  6       N                                     0    0
  667. ║  REELS      N  4       N                                     0    0
  668. ║  MINUTELEN  N  3       N                                     0    0
  669. ║  START_DAT  D  10      N                                     0    0
  670. ║  END_DATE   D  10      N                                     0    0
  671. ║  ACTOR      C  30      O     Actor                           2    1
  672. ║  ACTRESS    C  30      K     Actress                         2    38
  673. ║  SUPPORT    M  10      O     Support Memo                    5    1
  674. ║  MUSIC      M  10      O     Music Memo                      5    26
  675. ║  CREDITS    M  10      O     Credits Memo                    5    52
  676. ║
  677.  
  678.  
  679.  
  680.   dBase Field Info .......
  681.  
  682.                        The dBase field Name, Type and Length are
  683.                        displayed as an aid in working out the Handling
  684.                        info required by QRDB.
  685.  
  686.   QRDB Handling Info .......
  687. ║ │                 │ │(N)/A                                           │    ║
  688. ║ │                 │ │(O)pt                                           │    ║
  689. ║ │                 │ │(R)eq                                           │    ║
  690. ║ │Name      Typ Len│ │(K)ey  Display Label                   Line Col │    ║
  691.  
  692.  
  693.  (N)/A-(O)pt-(R)eq-    Decide if the field will be a (K)ey field, a (D)isplay
  694.               (K)ey    Field or a (N)ot Required Field. Fields coded (N)
  695.                        are not used by QRDB. Memo fields must be coded (O)
  696.                        or (N), they can NOT be a key field. In the example
  697.                        the fields SUPPORT, MUSIC and CREDITS are memo
  698.                        fields.
  699.  
  700.   Display Label        This is the Label QRDB will use when displaying the
  701.                        associated field data.
  702.  
  703.   Line                 This is the line that the Label and the Field data
  704.                        data will be placed on when QRDB is displaying the
  705.                        data.
  706.  
  707.   Col                  This is column that the first character in the label
  708.                        will be placed in. When a field is displayed the
  709.                        label is followed by a colon and a space and then
  710.                        the data. Labels are not displayed if the field
  711.                        is empty.
  712.  
  713.   After the above Setup is complete go to the operations menu and Build
  714.   the Type 3 DB Index. If ever changes are made to the .Dbf database
  715.   files outside of QRDB you will have to repeat this Build function.
  716.  
  717.   If you would like to use the type 3 data base, let's say for it's Memo
  718.   display capability and don't use a dBase compatable Data Base program.
  719.   You can use the Shareware program dBuddy to create the required files.
  720.   dBuddy (Data Base Buddy) is a dBase tool, it will build dBase III or
  721.   IV compatable Dbf and .Dbt files, either empty dBase files or it can
  722.   extract data from text files. dBuddy will Export to character
  723.   delimited files or text files, memo's are also exported. dBuddy is
  724.   available on Mountain Retreat 1:216/506, 408-335-4595. It can be
  725.   Freq'd under the magic name dBuddy.
  726.  
  727.  
  728.   Disclaimer agreement
  729.  
  730.     Users of QRDB and QRDBMGR must except the following disclaimer
  731.     agreement:
  732.  
  733.     QRDB and it's utilities are provided AS IS. The Author makes no
  734.     Warranty of any kind, expressed or implied. In addition THE AUTHOR
  735.     ASSUMES NO LIABILITY FOR DAMAGES WHICH MAY RESULT WHICH MAY RESULT
  736.     FROM THE USE OF QRDB, QRDBMGR or associated utilities.
  737.  
  738.    History
  739.  
  740.     Version 1.00    Initial Release
  741.     Version 1.01    Added a Main Menu help function
  742.     Version 1.02    Added a type 2 data import function and fixed
  743.                     a bug in the type 3 data dase setup functions
  744.     Version 1.03    Changed screens and added local mode default.
  745.     Version 1.04    MultiNode support added
  746.     Version 1.05    Beta Release switched to use of DorInfo1.Def
  747.                     in order to make the door useable on more systems.
  748.     Version 1.06    Release of DorInfo1.Def version
  749.     Version 1.07    Added support for dBase III and dBase IV memos
  750.                     Added support for dual word searches
  751.     Version 1.08    Improved dBase searches added dual word searches
  752.                     and speed.
  753.     Version 1.09    Miner changes mainly in docs to aid in setup
  754.     Version 2.0     Changed QRDBMgr to allow the rebuilding of Index
  755.                     files if changes have been made to the dBase
  756.                     .DBF files. Changed QRDB to allow smoother exit
  757.                     from Search functions.
  758.     Version 2.1     Added Browse function to type 2 and 3 database
  759.                     menus. Added a Pause Page Toggle to all types.
  760.                     Stoped scrolling the screen when displaying
  761.                     the number of records searched. QRDB now overwrites
  762.                     the message for a cleaner display.
  763.     Version 2.2     In type 2 database if Read access was not given then
  764.                     then Write access was locked out. QRDB will now
  765.                     allow you to give a user Write access without giving
  766.                     read access.
  767.     Version 2.3     Improved Browse feature. Added capability to a Type 2
  768.                     database to a comma delimited file.
  769.     Version 2.3a    Main menu can be bypass, command line option, fix.
  770.     Version 2.3b    Program now gives full pathname in .Key not found
  771.                     Error message. Moved the Browse function to the
  772.                     top position in the menu. Changed the timer routine
  773.                     I was using, it could possibly lock a system.
  774.     Version 2.4     Added additional drop carrier protection, added
  775.                     escape from data entry feature.
  776.     Version 3.0     Beta version, Major upgrade, adds edit to type 2
  777.                     database and adds Add, Edit and Delete to type 3.
  778.                     User has edit/delete access to any record he creates.
  779.             3.0B    Fixed level problem, a level equal to or greater than
  780.                     the level set in QRDB now has access. Prior to fix
  781.                     user level had to be greater for access.
  782.             3.1     Beta status Removed, Main Menu Help problem fixed and
  783.                     Memo Display bug fixed.
  784.             3.2     Type 3 Browse Bug fix.
  785.             3.3     Cosmetic Bug fix, the word changed is no longer
  786.                     displayed when entering a dBase record.
  787.             3.4     dBase file handler Bug Fix
  788.  
  789.     QRDB is ShareWare, a $25 registration fee is required. When you
  790.     register send me a 65 character message of your choice. You will be
  791.     sent a new QRDB.KEY file. Your 65 character message will replace the
  792.     following line in the QRDB menu.
  793.  
  794.   ╠════════════════════════════════════════════════════════════════════════╣
  795.   ║      QRDB Door - Mt. Retreat Software - Support BBS (408)335-4595      ║
  796.   ╚════════════════════════════════════════════════════════════════════════╝
  797.     In addition this new Key will prevent the QRDBMGR from displaying
  798.     it's startup message.
  799.  
  800.  
  801.     If you decide to continue useing QRDB after a 90 day trial period
  802.     you are expected to register. This is a one time registration your
  803.     key will work with all revisions.
  804.  
  805.     Please send your registration fee to:
  806.  
  807.              John Jamieson
  808.              Mountain Retreat Software
  809.              555 Buckeye St.
  810.              Felton Ca, 95018
  811.  
  812.     For support contact:
  813.  
  814.              Fidonet 1:216/506
  815.              Internet John.Jamieson@f506.n216.z1.FIDONET.ORG
  816.              BBS phone (408)335-4595
  817.              Voice (408)335-4672
  818.  
  819.  
  820.     
  821.